[doc] devex roadmap #4533

sblackshear · 2022-09-08T20:42:30Z

Document upcoming changes to Sui dev experience in one place

randall-Mysten · 2022-09-08T20:51:40Z

DEVX_ROADMAP.md

@@ -0,0 +1,46 @@
+# Developer Experience Roadmap
+
+This is a list of the upcoming DevX changes in the next 30 days


Could we include a start date for the 30 days? If I see this on the 28th day most of the items would be in the past already

DEVX_ROADMAP.md

randall-Mysten · 2022-09-08T20:54:41Z

DEVX_ROADMAP.md

+
+## JSON RPC
+*[Gateway deprecation] Sui_syncAccountState will be deprecated and removed.
+* [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately.


Suggested change

* [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately.

* [Gateway deprecation] Gateway’s `sui_executeTransaction` method will be replaced by fullnode’s `sui_executeTransaction` method, which has an extra parameter that allows users to choose whether a method should block or return immediately.

randall-Mysten · 2022-09-08T21:02:37Z

DEVX_ROADMAP.md

+  * get_events_by_recipient
+  * get_events_by_object
+  * get_events_by_timerange
+* sui_eventSubscription API that enables subscribing to all transaction events, including ones that don’t generate network activity (github)


why is (github) included in this line? Should be GitHub

this was a hyperlink in the source doc to this pull request #4288

randall-Mysten · 2022-09-08T21:03:41Z

DEVX_ROADMAP.md

+  * get_events_by_object
+  * get_events_by_timerange
+* sui_eventSubscription API that enables subscribing to all transaction events, including ones that don’t generate network activity (github)
+* A sui_call API that emulates transaction execution, but does not commit the same to the network, akin to eth_call in Ethereum.


Suggested change

* A sui_call API that emulates transaction execution, but does not commit the same to the network, akin to eth_call in Ethereum.

* A sui_call API that emulates transaction execution, but does not commit the transaction to the network, akin to eth_call in Ethereum.

randall-Mysten · 2022-09-08T21:05:36Z

DEVX_ROADMAP.md

+
+## SDK (Typescript, Rust)
+* Reliability improvements in Typescript SDK support for sui_publish API
+* Support for sui_subscribeEvent in Typescript SDK


Suggested change

* Support for sui_subscribeEvent in Typescript SDK

* Support for `sui_subscribeEvent` in the Typescript SDK

Or it could be "Support for the sui_subscribeEvent method in the Typescript SDK."

randall-Mysten · 2022-09-08T21:06:47Z

DEVX_ROADMAP.md

+* Rust SDK will be kept at parity with the Typescript SDK when feasible
+
+# Sui Move
+* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation.


Suggested change

* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation.

* Support for dynamic access of child objects to nullify the need to pass child objects explicitly in a transaction and to enable implementation of design patterns/collections that require pointer-like parent->child representation.

randall-Mysten · 2022-09-08T22:35:11Z

DEVX_ROADMAP.md

+## JSON RPC
+*[Gateway deprecation] Sui_syncAccountState will be deprecated and removed.
+* [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately.
+* Pagination support for the following APIs.


are these all APIs or methods of the Sui API?

these are a subset that may potential return a very lengthy list and hence requires pagination.

randall-Mysten · 2022-09-08T22:37:43Z

DEVX_ROADMAP.md

+
+# Sui Move
+* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation.
+* Support for passing strings and object ID's encodings to entry functions


Suggested change

* Support for passing strings and object ID's encodings to entry functions

* Support for passing strings and object ID encodings to entry functions

or encoded object IDs?

randall-Mysten · 2022-09-08T22:38:18Z

DEVX_ROADMAP.md

+# Sui Move
+* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation.
+* Support for passing strings and object ID's encodings to entry functions
+* [done] Support for passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management.


[done] means completed? Complete is a better word here, Done refers to food...I cooked it until the food was was done. I worked until the project was finished/completed.

if PRs are merged but not yet tagged for release we should not mark them as done.

janetwu11 · 2022-09-08T23:22:16Z

DEVX_ROADMAP.md

+# Sui Move
+* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203))
+* Support for passing strings and object ID's encodings to entry functions
+* [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management.


@sblackshear did you add the [done]? if they are only merged and not yet tagged for release they strictly speaking it is not usable. It may be good to leave out the [done] notation and direct people to the release notes instead.

+1 to Janet

janetwu11

Adding some comments inline.

srinath-mysten · 2022-09-09T15:54:01Z

DEVX_ROADMAP.md

+# Sui Move
+* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203))
+* Support for passing strings and object ID's encodings to entry functions
+* [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases wrt payments and coin management.


nit: Italize wrt

janetwu11 · 2022-09-09T22:26:59Z

DEVX_ROADMAP.md

+  * `get_events_by_object`
+  * `get_events_by_timerange`
+* A `sui_call` API that emulates transaction execution, but does not commit the transaction to the network, akin to eth_call in Ethereum. This is useful for gas cost prediction and transaction effect simulation.
+* [done] `sui_eventSubscription` API that enables subscribing to all transaction events, including ones that don’t generate network activity ([issue](https://github.com/MystenLabs/sui/pull/4288))


reference to [done]

janetwu11 · 2022-09-09T22:27:09Z

DEVX_ROADMAP.md

+# Sui Move
+* Support for dynamic access of child objects to avoid explicitly passing child objects as transaction inputs and to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203))
+* Support for passing strings and object ID encodings to entry functions
+* [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases *wrt* payments and coin management.


reference to [done]

janetwu11 · 2022-09-09T22:27:21Z

DEVX_ROADMAP.md

+* Support for dynamic access of child objects to avoid explicitly passing child objects as transaction inputs and to enable implementation of design patterns/collections that require pointer-like parent->child representation. ([issue](https://github.com/MystenLabs/sui/issues/4203))
+* Support for passing strings and object ID encodings to entry functions
+* [done] This frequently requested feature allows passing a vector of objects to entry functions which will open up a variety of flexible use cases *wrt* payments and coin management.
+* [done] A collection of cryptographic libraries are exposed as Move native functions to use on-chain. They can be found at:


reference to [done]

srinath-mysten · 2022-09-09T15:58:11Z

DEVX_ROADMAP.md

@@ -0,0 +1,50 @@
+# Developer Experience Roadmap


@sblackshear @janetwu11 Does it make sense to explicitly point out breaking changes ?

Spoke with Janet and resolving this.

sblackshear requested review from janetwu11 and srinath-mysten September 8, 2022 20:42

sblackshear requested a review from randall-Mysten as a code owner September 8, 2022 20:42

sblackshear force-pushed the devex_roadmap branch from 2b80d11 to 3c4d1b8 Compare September 8, 2022 22:44

randall-Mysten reviewed Sep 8, 2022

View reviewed changes

janetwu11 reviewed Sep 8, 2022

View reviewed changes

janetwu11 reviewed Sep 9, 2022

View reviewed changes

srinath-mysten reviewed Sep 9, 2022

View reviewed changes

sblackshear force-pushed the devex_roadmap branch 2 times, most recently from 8e91493 to 6a6bea5 Compare September 9, 2022 21:43

janetwu11 reviewed Sep 9, 2022

View reviewed changes

[doc] add devex roadmap document

91b473b

sblackshear force-pushed the devex_roadmap branch from 6a6bea5 to 91b473b Compare September 9, 2022 22:36

janetwu11 approved these changes Sep 9, 2022

View reviewed changes

srinath-mysten approved these changes Sep 9, 2022

View reviewed changes

sblackshear merged commit a99754b into MystenLabs:main Sep 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[doc] devex roadmap #4533

[doc] devex roadmap #4533

sblackshear commented Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

janetwu11 Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

janetwu11 Sep 8, 2022

randall-Mysten Sep 8, 2022

randall-Mysten Sep 8, 2022

janetwu11 Sep 8, 2022

janetwu11 Sep 8, 2022

srinath-mysten Sep 9, 2022

janetwu11 left a comment

srinath-mysten Sep 9, 2022

janetwu11 Sep 9, 2022

janetwu11 Sep 9, 2022

janetwu11 Sep 9, 2022

srinath-mysten Sep 9, 2022

srinath-mysten Sep 9, 2022

		@@ -0,0 +1,46 @@
		# Developer Experience Roadmap

		This is a list of the upcoming DevX changes in the next 30 days

	* [Gateway deprecation] Gateway’s sui_executeTransaction will be replaced by fullnode’s sui_executeTransaction which has an extra parameter that allows users to choose if a method should block or return immediately.
	* [Gateway deprecation] Gateway’s `sui_executeTransaction` method will be replaced by fullnode’s `sui_executeTransaction` method, which has an extra parameter that allows users to choose whether a method should block or return immediately.

	* A sui_call API that emulates transaction execution, but does not commit the same to the network, akin to eth_call in Ethereum.
	* A sui_call API that emulates transaction execution, but does not commit the transaction to the network, akin to eth_call in Ethereum.

	* Support for sui_subscribeEvent in Typescript SDK
	* Support for `sui_subscribeEvent` in the Typescript SDK

	* Support for dynamic access of child objects to nullify the need to explicitly pass child objects in a transaction as well as to enable implementation of design patterns/collections that require pointer-like parent->child representation.
	* Support for dynamic access of child objects to nullify the need to pass child objects explicitly in a transaction and to enable implementation of design patterns/collections that require pointer-like parent->child representation.

	* Support for passing strings and object ID's encodings to entry functions
	* Support for passing strings and object ID encodings to entry functions

[doc] devex roadmap #4533

[doc] devex roadmap #4533

Conversation

sblackshear commented Sep 8, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janetwu11 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment